home *** CD-ROM | disk | FTP | other *** search
/ MacWorld 1999 August / Macworld (1999-08).dmg / Updaters / Mizer™ 1.6 Update / New Documentation / Mizer™ 1.6 Manual < prev    next >
Text File  |  1999-06-01  |  19KB  |  341 lines

  1. Mizer™ 1.6 Manual
  2.  
  3. Antimony Software
  4. http://www.antimonysoftware.com
  5. support@antimonysoftware.com
  6. 1-662-263-5412 (fax)
  7.  
  8.  
  9. Contents:
  10.  
  11. Why Use Mizer™?
  12. How does Mizer™ do it?
  13. How easy is it to use Mizer™?
  14. Setting Mizer™'s preferences.
  15. Some hidden features in version 1.6.
  16. Optimizing HTML files and folders with Mizer™.
  17. Using the Get File Info command in Mizer™.
  18. Apple Scripting Mizer™.
  19. What Mizer™ doesn't do.
  20. Getting help with Mizer™.
  21. Contact information for Antimony Software.
  22.  
  23.  
  24. Why use Mizer™?
  25.  
  26. If you aren't using Mizer™, your pages aren't as fast as they could be. They aren't downloading as fast as they could be, and they aren't rendering as quickly as they could be. Speed is crucial for web pages, as most professionals are well aware.
  27.  
  28. The faster your page is readable by your visitors, the more will stick around to read what you have to say, and the better their impression will be of your site and your company and product or your client's site and product.
  29.  
  30. Everyone in business knows that more exposure with better first impressions translates to a lot more money generated from the marketing effort. That includes the first impression of all your clients if you design sites for others. Faster is better for business, and since Mizer™ can make all your pages faster, it will improve your business.
  31.  
  32. That's why you should use Mizer™, the fact that if everyone used Mizer™ on their web pages, it would save more than 27 billion bytes an hour in traffic is a really nice thought, but that isn't why you want to use it.
  33.  
  34. How does Mizer™ do it?
  35.  
  36. Mizer™ automatically removes unneeded information in HTML and JavaScript syntax making it smaller and more easily parseable by browsers. Depending on how your pages were made there is from 5 - 50% useless or redundant information in them. The most basic formatting for sake of readability typically introduces 5 - 10% of information as spaces, tabs, and returns that a browser must parse through and ignore. That information has a purpose - to make your syntax easily readable for authoring - but it is useless, slow fat for servers and browsers. The other forms of unnecessary information are actual syntax elements that are either unneeded as the case with many quotes around attribute values, many comments, many tag attributes and also many tags. These get introduced in two ways. You put them through habit or misunderstanding of what was actually needed, or your WYSIWIG authoring tool did for whatever reasons it has.
  37.  
  38. There are two ways you can fix that problem. The first and much harder, is you can re-read all the how-to information available about HTML, sorting out the good from the bad, until you can write pages by hand, provided you can take the eye strain involved since you can't format it so you can read it anymore to do this, that are as lean and fast as possible.
  39.  
  40. Then again you could just use Mizer™ and forget about it.
  41.  
  42. It won't matter if you go with choice number one or choice number two, but as long as you do a domino effect will start that will result in your pages being much, much faster:
  43.  
  44. 1: Since the source file is smaller, the server reads and sends it faster so the browser starts receiving the information sooner.
  45.  
  46. 2: The browser is able to parse the arriving data much faster because all unnecessary data has been eliminated. This allows the browser to make http requests for images faster and allows text information to the rendered much more quickly by the browser. This helps hold attention spans of viewers because text elements appear almost immediately. As has been described by Mizer™ users, the text "snaps" onto the page.
  47.  
  48. 3: Since the browser was able to render the text portions of the page more quickly, rendering images is also faster because there is less conflict for cpu power between rendering the text and rendering the images. Images also arrive sooner to be rendered sooner because they were requested sooner.
  49.  
  50. 4: Because everything involved in retrieving a page is speed up, overall server performance and connection performance is increased as well. Page retrievals take less time to complete so the average number of conncurrent connections is reduced meaning more server cpu time and more connection bandwidth are available to satisfy each individual page request.
  51.  
  52. What Mizer™ does is much more than just making HTML files a little smaller, as you can see now. Compared to optimizing images properly, which would cut much more raw size off your page than that can from your source with Mizer™ - at least for a graphics intensive page - it may seem trivial to knock a k or two more off, but when you realize how and how much those particular bytes make a difference in overall page performance, the need for Mizer™ is clear.
  53.  
  54. Here's an example below.
  55.  
  56. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2//EN">
  57.  
  58. <HTML>
  59.  
  60.      <HEAD>
  61.           <TITLE>Why use Mizer?</TITLE>
  62.      </HEAD>
  63.      
  64.      <BODY BGCOLOR="#E6E6E6">
  65.      
  66.      <P>Because while this nicely formatted source is easy to read
  67.      and pretty, it's bloody inefficient for the browser.</P>
  68.      
  69.      </BODY>
  70.  
  71. </HTML>
  72.  
  73. The above source is 323 bytes, but only 224 bytes are important. Eliminating the other 99 bytes, more than 30% of the size, will not affect the way it renders at all.
  74.  
  75. It will only make it download in about 30% less time and render in a browser upwards of 50% faster overall. The cumulative effect of optimized HTML is much greater than the savings in file size alone.
  76.  
  77. The bottom line, whether Mizer™ saved .5% or 50% is your page will be seen by your viewers faster, and as the maxum goes - "Fast enough never is."
  78.  
  79. Also, if you pay for bandwidth, Mizer™ will pay for itself. Saving a few more K here and there adds up quickly to megabytes and gigabytes on popular sites. Taking the very popular and cool Version Tracker site as an example, using Mizer™ on just one page would save over 650MB per day of bandwidth. (Version Tracker can be found at http://www.versiontracker.com and comes highly recomended as a great Macintosh resource.)
  80.  
  81. On top of that, Mizer™ can save you quite a bit of time. With Mizer™ you don't have to worry about how neatly or carefully you format your HTML syntax. You can space it out and arrange your source for easiest authoring, without any worry at all about page performance.
  82.  
  83.  
  84. How easy is it to use Mizer™?
  85.  
  86. It's as simple as Dragging & Dropping an HTML file or a Folder of HTML files onto Mizer™ after you have finished your page or site.
  87.  
  88. Mizer™ automatically processes all HTML files and then you upload them to you server. If you use the included "Optimize & Upload Site w/Fetch" Applet the entire process is reduced to selecting your main site folder and clicking OK. Your optimized pages are uploaded to your server and your original pages are maintained in tact locally for future editing.
  89.  
  90. Besides standard dialogs to select files and folders to process when you aren't using Mizer™ as a Drag & Drop application the only dialog Mizer™ has is a simple preferences dialog.
  91.  
  92. Setting Mizer™'s preferences.
  93.  
  94. Mizer™ can be configured to perform some useful tasks while it does HTML optimization with the preferences dialog.
  95.  
  96.  
  97.  
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123. 1: Make back-up before optimizing
  124.  
  125. The backup feature in Mizer™ IS NOT intended for general usage. It is a safety feature in the frequent case when people jump straight in before reading the documentation, and as such is enabled by default when you first use Mizer™.
  126.  
  127. The back-up files created by Mizer™ will always be located in the same Folder as the original files and have the file extension 'bac' instead of the original extension.
  128.  
  129. The HTML optimization process destroys original syntax formatting making the resulting file difficult to edit by hand. The JPEG optimization removes application specific information in JPEG files, which may cause certain settings to be lost when the images are reopened to edit, but will not effect the saved image data at all.
  130.  
  131. It is important to maintain an editing copy of your site locally when using Mizer™. You should wait until your files are ready to upload and then make a copy of them manually (Command - D in the Finder will duplicate a file or folder) to perform optimization on. The optimized copies should be uploaded, then deleted locally leaving your original editing files on your hard drive, and the optimized published files on your server.
  132.  
  133. Once you are following this procedure it is best to turn off the backups setting to keep extra files from being created.
  134.  
  135. 2: Generate log files
  136.  
  137. Mizer™ can keep a central log file detailing the results of files that it processes. This log is simply easy-to-read information on file sizes. There is no reason to ever turn logging off. It is unobtrusive and in the background even if you don't often examine the log file.
  138.  
  139. Examining files optimized by Mizer™ in the Finder will usually show a much greater savings in file size than the log reports. This is because Mizer™ also strips all resource forks from files and only reports actual savings in HTML size in its log file. Resource sizes aren't added into the total.
  140.  
  141. Resource forks are stripped for convenience so the Finder will report accurate sizes for your files, and to reduce the incidence of accidental file corruption from FTP clients performing automatic MacBinary encoding to preserve the resource fork of uploaded Macintosh files.
  142.  
  143. 3: Set log file creator to:
  144.  
  145. You can set the application to open Mizer™'s log files by setting the file creator code. There are two ways to do this. If you know the creator code for the application, such as BBEdit, that you would like to open Mizer™'s log files, you can type it in the text box. For example the four byte creator code for BBEdit is 'R*ch'.
  146.  
  147. If you don't know the four byte creator code you can hit the "Select Application" button and a dialog will be show allowing you to chose an application to open Mizer™'s log files with.
  148.  
  149. 4: Set optimized file creator to:
  150.  
  151. There are two ways Mizer™ can handle the file creators for optimized HTML files. (This only applies to optimized source files, Mizer will not change the creator code of image files.)
  152.  
  153. The "Same as original file" option will result in optimized source files belonging to the same application as the original files did. The creator code will not be changed with this option.
  154.  
  155. The other choice sets all optimized files to belong to a predetermined application by assigning them the creator code for that application.
  156.  
  157. If you don't know the four byte creator code you can hit the "Select Application" button and a dialog will be show allowing you to chose an application to use.
  158.  
  159. 4: Tag optimization
  160.  
  161. This enables tag level optimization that removes optional closing tags where they will not change the appearance of a page. The following closing tags are currently removed when tag optimization is enabled.
  162.  
  163. Tag optimization is now controlled by the contents of STR# resource 257 which contains a list of all HTML tags to be removed when this setting is enabled.You can configure which tags will be removed by tag optimization by editing this resource in ResEdit, a freeware resource editor available from Apple.
  164.  
  165. The default tags removed by the tag optimization setting are:
  166.  
  167. <X-CLARIS-TAGVIEW
  168. </DD
  169. </DT
  170. </LI
  171. </OPTION
  172. </COLGROUP
  173. <X-SAS-WINDOW
  174. </HEAD
  175. </HTML
  176. </BODY
  177.  
  178. Individual tags can be removed or others added as needed. When adding tags you should include only the opening part of the tag, as above, and not add the closing '>' to the string.
  179.  
  180. The corresponding setting interface for direct configuration of tag optimization within the application will be added in the next update. This is a tip to make use of a currently hidden feature.
  181.  
  182. 5: Strict quote rules
  183.  
  184. When this setting is enabled Mizer™ will strictly follow the letter of the HTML specification when determining if quotes around attribute values should be removed or not.
  185.  
  186. Generally, you will want to let Mizer™ use normal liberal quote rules that determine if quotes can be removed from an attribute value based on actual browser behavior instead, as savings will be much greater without compatibility issues.
  187.  
  188. However, due to popular request, the option of strict quotes is available now.
  189.  
  190. 6: JPEG optimization
  191.  
  192. This setting enables the new JPEG optimization.
  193.  
  194. This is a lossless process that removes all unneeded information from the JPEG without changing its compression. It has been tested with all current browsers, and most old browser versions to be fully compatible with browsers supporting in-line JPEG display.
  195.  
  196. It has also been tested with all versions of Photoshop with JPEG support to be safe, but this process may interfere with some applications reading JPEG files causing them not to believe the file is a valid JPEG because a common marker used by many applications to test file type will be removed. This does not make the JPEG invalid, but it may make some applications that check file type based on this marker to not recognize the file as a JPEG, and therefore should not be performed on JPEG files that may be exchanged with others for editing.
  197.  
  198. Some hidden features in version 1.6.
  199.  
  200. File filtering in this version is completely changed to be more easily configurable, though the corresponding interface has not been added. File extensions that are recognized as HTML files are now contained in STR# resource 256. You can add or remove extensions now using ResEdit or Resorcerer. File extensions recognized for other file types are also controlled this way, all STR# resources that are user-editable are clearly labeled with their purpose.
  201.  
  202. HTML comment removal has also been added as of version 1.5, and the strings that are used to identify comments that are server side includes or other preprocessing directives are also contained in a STR# resource, which may be edited using ResEdit or Resorcerer.
  203.  
  204. Tag optimization, previously described in the preferences section, is also controlled in a like manner.
  205.  
  206. A future update will complete the interface to allow configuration of these features from an application dialog, but you can still make use of the functionality now.
  207.  
  208. Optimizing HTML files and folders with Mizer™.
  209.  
  210. Mizer™ recognizes HTML files by their file extensions. There are seven extensions that it recognizes:
  211.  
  212. '.html'
  213. '.htm'
  214. '.shtml'
  215. '.txt'
  216. '.cfm'
  217. '.incl'
  218. '.lasso'
  219.  
  220. Mizer™ will scan and attempt to optimize the HTML syntax in any file ending in one of those three extensions that you open with Mizer™ or Drag & Drop onto it.
  221.  
  222. For Drag & Drop use, simply drag the file onto Mizer™. The application will launch, optimize the file, and perform any other actions that are set in Mizer™'s preferences such as creating a back-up file and setting the optimized file's creator type.
  223.  
  224. You should not use Mizer™ on your HTML file until you are done with creating and testing it. Mizer™ is the last step before Web publishing, and not a tool to employ before your HTML is in final form.
  225.  
  226. If there is any possibility that you HTML may need to be revised in the future you should make sure to retain a local back-up copy for editing. Optimized HTML files are very difficult to read because the process of optimization removes formatting for human readability.
  227.  
  228. The best approach is to maintain a local copy of your entire site for editing. When you make changes, copy the changed files, optimize the copies and upload the optimized files to you server preserving the integrity of your local HTML for future editing.
  229.  
  230. Mizer™'s automatic back-up capability is provided only for safety, and is not necessarily the best approach for good organization of your files.
  231.  
  232. Using the Get File Info... command in Mizer™.
  233.  
  234. Mizer 1.6 adds the Get File Info command to the edit menu. With this you can view information about optimized and unoptimized files.
  235.  
  236.  
  237.  
  238.  
  239.  
  240.  
  241.  
  242.  
  243.  
  244.  
  245.  
  246.  
  247.  
  248.  
  249.  
  250.  
  251.  
  252.  
  253.  
  254.  
  255.  
  256. This command (File -> Get File Info... or Command - I) only displays information. It will not change files in any way.
  257.  
  258. Apple Scripting Mizer™.
  259.  
  260. Mizer™ is fully and easily Apple Scriptable. Like most Drag & Drop applications it only supports the Required Apple Events Suite and processing is initiated be sending Mizer™ an open Apple Event.
  261.  
  262. A simple Apple Script to do that is below.
  263.  
  264. -- Very simply scripting example for Mizer 1.0
  265.  
  266. property gSourceFolder : ""
  267.  
  268. -- Uses the finder to show a dialog to select a source
  269. -- folder to optimize
  270. on run
  271.      tell application "Finder"
  272.           try
  273.                set folderAlias to choose folder with prompt
  274.                     "Select the folder to optimize:"
  275.                set gSourceFolder to folderAlias
  276.           on error -- e.g. user cancelled
  277.                return
  278.           end try
  279.      end tell
  280.      
  281.      -- Mizer is a Drag & Drop application, so opening 
  282.      -- a file or folder will initiate all processing and
  283.      -- optimization of files. Scripting it is as easy as it gets.
  284.      
  285.      tell application "Mizer 1.0"
  286.           open gSourceFolder
  287.           quit
  288.      end tell
  289. end run
  290.  
  291. You can easily incorporate Mizer™ into more complex scripts utilizing many applications. A sample script "Optimize & Upload w/Fetch" is included that demonstrates the potential for scripting Mizer™ to work with other applications.
  292.  
  293. It fully automates the entire process of backing-up, optimizing, and uploading web a site. (Take note that your destination URLs need to be in the form of ftp://login:password@host/path/ for the script. See the script source for detailed commemts.)
  294.  
  295.  
  296. What Mizer doesn't do.
  297.  
  298. Mizer™ does a lot to optimize your HTML files, but there are things that could be done to make them even smaller that it doesn't.
  299.  
  300. Those things require an element of human judgment. Should you wish to make your files as small as possible you should also:
  301.  
  302. 1: Keep Meta tag and other non-displaying information to the bare functional minimum.
  303.  
  304. 2: Use shorter relative paths in URLs instead of longer absolute ones.
  305.  
  306. 3: Use the shortest naming conventions for your files that you can to maintain adequate organization - "home.html" not "homepage.html"
  307.  
  308. 4: Consider using cascading style sheets instead of many occurrences of modifier tags.
  309.  
  310. Remember, that every byte saved counts to speed downloading and rendering, and it isn't any more trouble to make HTML with file size in mind than it is to not.
  311.  
  312.  
  313. Getting help with Mizer™.
  314.  
  315. Mizer™ is simple and safe. There is little chance that you will need to ask for help with it. However, given the fast pace at which HTML is changing, it is possible that unanticipated changes might create new issues to address and require changes in Mizer's engine.
  316.  
  317. If you notice any change in appearance to your Web pages after it has been optimized with Mizer please let us know immediately.
  318.  
  319. Send email to support@antimonysoftware.com with a description of the visual change and include the original and optimized files as an email attachment.
  320.  
  321. That way you can help us stay on top of change.
  322.  
  323. Should you need help with Mizer™, prompt support is available by email.
  324.  
  325. support@antimonysoftware.com
  326.  
  327.  
  328. Contact information for Antimony Software.
  329.  
  330. Antimony Software
  331. 2041 Sturgis-Maben Road
  332. Maben, MS 39750
  333. 1-662-263-5412 (fax)
  334.  
  335. http://www.antimonysoftware.com
  336. support@antimonysoftware.com
  337.  
  338.  
  339.  
  340.  
  341. © 1999 Antimony Software. All rights reserved. Antimony and Mizer are trademarks of Antimony Software. All other trademarks are the recognized properties of their respective holders.